Viewing Generic HTML Screen Element Identification Details

You can select any Generic HTML screen element in the Screen Elements tree to display its identification details in the Identification tab. This includes the Generic HTML Process (at the process level), the Generic HTML Document (at the document level), as well as the various screen element types, such as the Generic HTML TextBox and Generic HTML Table.

For a list of the Generic HTML Browser functions, including many functions to work on the browser tabs, see Generic HTML Browser Library Object.

Generic HTML General Screen Element Identification Details

The following identification details are available for general Generic HTML screen elements in the in the Identification tab. For more information on working with the options in this tab, see Using the Identification Tab.

Option

Description

Enable Recognition When this checkbox is selected, the screen element and all its children are recognized when the project loads and can be used in projects. By default, all screen elements are recognized and can be used. Clear the checkbox if you want to disable a screen element, so that the screen element and all its children are ignored and not recognized when the project loads.
Edit code

When this checkbox is selected, you can make changes to the identification code in the Code tab.

The Edit code option is designed for advanced users only.

Multi Instance Settings

If the screen element might have multiple instances, select the Has multi instances checkbox, and then specify which instance should be given precedence: Last Focused, First Recognized, or Last Recognized.

For more information, see Multiple Instances of the Same Application.

Advanced Settings

If the select the screen element is dynamic, and its properties can change without events being raised, select the Enable Continuous Mode checkbox. This option enables polling (values are refreshed every second) for the Inner HTML, Inner Text (in some cases this is a Value), Enabled, and Visible properties of the  screen element.
Screen Element Type

The type of captured screen element. The Real-Time Designer automatically selects the type, but you can change the default selected, if required, by selecting another option from the Screen Element Type drop-down list. This is useful if you would like to view the functionality of another screen element type in the Functionality tab.

From version 7.2, the functionality is built in to the ScreenPluginGenericHTML library, which you can access by selecting Project > References > Library References.

The options in the Screen Element Type drop-down list include:

  • Generic HTML Process (only available when the process screen element is selected, as described in Generic HTML Process Screen Element Details)

  • Generic HTML Document (only available when the document screen element is selected, as described in Generic HTML Document Screen Element Details)

  • Generic HTML Element

  • Generic HTML CheckBox

  • Generic HTML Combo Box

  • Generic HTML Hyperlink

  • Generic HTML Image

  • Generic HTML List Box

  • Generic HTML Radio Button

  • Generic HTML Table

  • Generic HTML Text Area

  • Generic HTML Text Box

  • Generic HTML Button

Relations Area

The Main Relation Type drop-down list shows the available relation types for the screen element. The Real-Time Designer automatically selects the optimal relation type, either:

  • My Parent Document is: The parent screen element of the screen element hierarchy.

  • The Element I am child of is: The parent Generic HTML Document of the screen element in the hierarchy.

Self properties

All the properties that can be used to uniquely identify the screen element. The Real-Time Designer selects the optimal properties, indicated by the Used checkboxes.

You must use at least one of the following mandatory self-properties: Name, XPath, Selector, ID, Parent Id, and Parent Name.

The available self properties include:

  • Name: The internal name of the HTML element within the HTML document.

  • XPath: The XPath to the HTML object, which uses a path like syntax to identify and navigate to nodes in an XML document.

  • Selector: The CSS Selector to identify the HTML element. When using this property, all queries are absolute, meaning that they cannot be used as an anchored element, but only as a child that has a document element as its immediate parent. Because the query can be specified in numerous ways, solution implementation engineers or connectivity developers typically need to analyze the HTML domain to write a selector query. In previous versions, the selectors were based on using a parent-child axis. From APA 7.7, smarter selection generation has now been added and also uses ID, Name, CSS Class and Node Type. This generates shorter and more efficient selectors.

    To learn more about CSS Selectors, click here.

  • ID: The unique ID for the HTML element within the HTML document.

  • Parent Id: The unique ID for the parent element.

  • Parent Name: The name of the parent element.

  • Tag Name: The tag of the HTML element that describes its type.

  • Class: The element class.

  • Parent Class: The parent class.

  • Order: Index.

  • Children Count: The number of children.

  • Attributes: A key/value pair of strings that represents any information regarding that attribute. This property supports multiple values, delineated with |;.

  • Visibility: A boolean value to specify whether to recognize the screen element according to his visible state, because some HTML elements might exist on the web page, but still not visible. By default, this property is cleared. If you want to recognize a captured Generic HTML screen element when it became only visible in the page, check this property and set the true value.

  • Inner Text: The text between the start and end tags (the existing content of the object). You can include a * wildcard in the value of this property.

You can change the order of the self properties in the Real-Time Screen Connectivity > Generic HTML Plugin Configuration branch of the System Settings window.

Generic HTML Document Screen Element Details

The following details and options are available for Generic HTML Document screen elements in the Identification tab. For more information on working with the options in this tab, see Using the Identification Tab.

Option

Description

Enable Recognition When this checkbox is selected, the Generic HTML Document and all its children are recognized when the project loads and can be used in projects. Clear the checkbox if you want to disable the document, so that the document and all its children are ignored and not recognized when the project loads.
Edit code

When this checkbox is selected, you can make changes to the identification code in the Code tab.

The Edit code option is designed for advanced users only.

Multi Instance Settings

If the Generic HTML Document might have multiple instances, for example the same web page opened in different tabs in a web browser, select the Has multi instances checkbox, and then specify which instance should be given precedence: Last Focused, First Recognized, or Last Recognized.

For more information, see Multiple Instances of the Same Application.

Advanced Settings

If the Generic HTML Document is dynamic, and its properties can change without events being raised, select the Enable Continuous Mode checkbox. This option enables polling (values are refreshed every second) for the Inner HTML, Inner Text (in some cases this is a Value), Enabled, and Visible properties of the  screen element.
Screen Element Type

The type of captured screen element, in this case Generic HTML Document.

Relations Area

The Main Relation Type drop-down list shows the available relation types for the Generic HTML Document. The Real-Time Designer automatically selects the optimal relation type, either:

  • The Process I am Document of:The process that hosts the HTML document, of any level.

  • The Process I am Top Document of: The process that hosts the top HTML document.

  • The Document I am child of is: The parent HTML document of the current document.

Self properties

All the properties that can be used to uniquely identify the Generic HTML Document. The Real-Time Designer automatically selects the optimal properties, indicated by the Used checkboxes.

The available self properties include:

  • Url: The URL of the HTML document in the web application.

  • Title: The visible title of the web page from which the HTML document was captured.

  • Ids of Contained Elements: The IDs of one or more of the elements contained in the HTML document, separated by semicolons. By default, the ID of the first element in the document that has an ID attribute is listed here. If you select this property, AND logic is used to check for all the specified elements.

  • ActiveTab: Whether this tab is the only recognized tab on the page (True). This property should be used in conjunction with the URL or Title.

  • Tab Id: The identification number of the tab. When the value of this self-property is set to 0, the Tab Id is ignored during identification, even if it is selected. To define a value for the Tab Id, use a Number business entity with the initial value 0.

  • Names of Contained Elements: The names of one or more elements contained in the HTML document, separated by semicolons. If you select this property, AND logic is used to check for all the specified elements.

  • Selector of Contained Element: The CSS Selector to identify an HTML element contained in the HTML document. When using this property, all queries are absolute, meaning that they cannot be used as an anchored element, but only as a child that has a document element as its immediate parent. Because the query can be specified in numerous ways, solution implementation engineers or connectivity developers typically need to analyze the HTML domain to write a selector query.

    To learn more about CSS Selectors, click here.

Generic HTML Process Screen Element Details

The following details and options are available for Generic HTML Process screen elements in the Identification tab. For more information on working with the options in this tab, see Using the Identification Tab.

Option

Description

Enable Recognition When this checkbox is selected, the Generic HTML Process and all its children are recognized when the project loads and can be used in projects. Clear the checkbox if you want to disable a process, so that the process and all its children are ignored and not recognized when the project loads.
Edit code

When this checkbox is selected, you can make changes to the identification code in the Code tab.

The Edit code option is designed for advanced users only.

Multi Instance Settings

The Has multi instances checkbox is selected and cannot be cleared for Generic HTML Process screen elements.

For more information, see Multiple Instances of the Same Application.

Advanced Settings

The Enable Continuous Mode checkbox is cleared and cannot be selected for Generic HTML Process screen elements.
Screen Element Type

The type of captured screen element, in this case Generic HTML Process.

Self properties

All the properties that can be used to uniquely identify the Generic HTML Process. The Real-Time Designer selects the optimal properties, indicated by the Used checkboxes.

The available self properties include:

  • My Process Name is: The name of the process. Regardless of the web browser, the name of the process should be rti_nativehost.

  • My Parent Process Name is: The name of the parent process, if such a process exists.

You can use the Process Explorer utility to verify the process level’s attributes.